IMContextSimple

GtkIMContextSimple is an input method supporting table-based input methods.

Compose sequences

GtkIMContextSimple reads compose sequences from the first of the following files that is found: ~/.config/gtk-4.0/Compose, ~/.XCompose, /usr/share/X11/locale/$locale/Compose (for locales that have a nontrivial Compose file). The syntax of these files is described in the Compose(5) manual page.

If none of these files is found, GtkIMContextSimple uses a built-in table of compose sequences that is derived from the X11 Compose files.

Note that compose sequences typically start with the Compose_key, which is often not available as a dedicated key on keyboards. Keyboard layouts may map this keysym to other keys, such as the right Control key.

Unicode characters

GtkIMContextSimple also supports numeric entry of Unicode characters by typing <kbd>Ctrl</kbd>-<kbd>Shift</kbd>-<kbd>u</kbd>, followed by a hexadecimal Unicode codepoint.

For example,

Ctrl-Shift-u 1 2 3 Enter

yields U+0123 LATIN SMALL LETTER G WITH CEDILLA, i.e. ģ.

Dead keys

GtkIMContextSimple supports dead keys. For example, typing

dead_acute a

yields U+00E! LATIN SMALL LETTER_A WITH ACUTE, i.e. á. Note that this depends on the keyboard layout including dead keys.

class IMContextSimple : IMContext {

protected

GtkIMContextSimple* gtkIMContextSimple;

GtkIMContextSimple* getIMContextSimpleStruct(bool transferOwnership);

void* getStruct();

this(GtkIMContextSimple* gtkIMContextSimple, bool ownedRef);

static GType getType();

this();

void addComposeFile(string composeFile);

void addTable(ushort[] data, int maxSeqLen, int nSeqs);

}

Constructors

this this(GtkIMContextSimple* gtkIMContextSimple, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new GtkIMContextSimple.

Members

Functions

addComposeFile void addComposeFile(string composeFile): Adds an additional table from the X11 compose file.
addTable void addTable(ushort[] data, int maxSeqLen, int nSeqs): Adds an additional table to search to the input context. Each row of the table consists of @max_seq_len key symbols followed by two #guint16 interpreted as the high and low words of a #gunicode value. Tables are searched starting from the last added.
getIMContextSimpleStruct GtkIMContextSimple* getIMContextSimpleStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*

Static functions

getType GType getType()

Variables

gtkIMContextSimple GtkIMContextSimple* gtkIMContextSimple;: the main Gtk struct

Inherited Members

From IMContext

gtkIMContext GtkIMContext* gtkIMContext;: the main Gtk struct
getIMContextStruct GtkIMContext* getIMContextStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
deleteSurrounding bool deleteSurrounding(int offset, int nChars): Asks the widget that the input context is attached to delete characters around the cursor position by emitting the ::delete_surrounding signal.
filterKey bool filterKey(bool press, Surface surface, Device device, uint time, uint keycode, GdkModifierType state, int group): Allow an input method to forward key press and release events to another input method without necessarily having a GdkEvent available.
filterKeypress bool filterKeypress(Event event): Allow an input method to internally handle key press and release events.
focusIn void focusIn(): Notify the input method that the widget to which this input context corresponds has gained focus.
focusOut void focusOut(): Notify the input method that the widget to which this input context corresponds has lost focus.
getPreeditString void getPreeditString(string str, PgAttributeList attrs, int cursorPos): Retrieve the current preedit string for the input context, and a list of attributes to apply to the string.
getSurrounding bool getSurrounding(string text, int cursorIndex): Retrieves context around the insertion point.
getSurroundingWithSelection bool getSurroundingWithSelection(string text, int cursorIndex, int anchorIndex): Retrieves context around the insertion point.
reset void reset(): Notify the input method that a change such as a change in cursor position has been made.
setClientWidget void setClientWidget(Widget widget): Set the client widget for the input context.
setCursorLocation void setCursorLocation(GdkRectangle* area): Notify the input method that a change in cursor position has been made.
setSurrounding void setSurrounding(string text, int len, int cursorIndex): Sets surrounding context around the insertion point and preedit string.
setSurroundingWithSelection void setSurroundingWithSelection(string text, int len, int cursorIndex, int anchorIndex): Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the [signal@Gtk.IMContext::retrieve_surrounding] signal, and will likely have no effect if called at other times.
setUsePreedit void setUsePreedit(bool usePreedit): Sets whether the IM context should use the preedit string to display feedback.
addOnCommit gulong addOnCommit(void delegate(string, IMContext) dlg, ConnectFlags connectFlags): The ::commit signal is emitted when a complete input sequence has been entered by the user.
addOnDeleteSurrounding gulong addOnDeleteSurrounding(bool delegate(int, int, IMContext) dlg, ConnectFlags connectFlags): The ::delete-surrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor.
addOnPreeditChanged gulong addOnPreeditChanged(void delegate(IMContext) dlg, ConnectFlags connectFlags): The ::preedit-changed signal is emitted whenever the preedit sequence currently being entered has changed.
addOnPreeditEnd gulong addOnPreeditEnd(void delegate(IMContext) dlg, ConnectFlags connectFlags): The ::preedit-end signal is emitted when a preediting sequence has been completed or canceled.
addOnPreeditStart gulong addOnPreeditStart(void delegate(IMContext) dlg, ConnectFlags connectFlags): The ::preedit-start signal is emitted when a new preediting sequence starts.
addOnRetrieveSurrounding gulong addOnRetrieveSurrounding(bool delegate(IMContext) dlg, ConnectFlags connectFlags): The ::retrieve-surrounding signal is emitted when the input method requires the context surrounding the cursor.